home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Utilities / htmldoc / man / man1 / htmldoc.1
Text File  |  2001-07-11  |  15KB  |  595 lines
  1.  
  2.  
  3.  
  4. htmldoc(1)            Easy Software Products           htmldoc(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        htmldoc - convert html source files into html, postscript,
  9.        or pdf.
  10.  
  11.  
  12. SSYYNNOOPPSSIISS
  13.        htmldoc [options] filename1.html [ ... filenameN.html ]
  14.  
  15.        htmldoc [options] -
  16.  
  17.        htmldoc [filename.book]
  18.  
  19.  
  20. DDEESSCCRRIIPPTTIIOONN
  21.        _H_T_M_L_D_O_C converts HTML  source  files  into  indexed  HTML,
  22.        PostScript,  or  Portable Document Format (PDF) files that
  23.        can be viewed online or printed.  With no  options  a  PDF
  24.        document is produced on stdout.
  25.  
  26.        The  second  form of _H_T_M_L_D_O_C reads HTML source from stdin,
  27.        which allows you to use _H_T_M_L_D_O_C as a filter.
  28.  
  29.        The third form of _H_T_M_L_D_O_C launches a  graphical  interface
  30.        that  allows  you to change options and generate documents
  31.        interactively.
  32.  
  33. CCOOMMMMOONN MMIISSTTAAKKEESS
  34.        There are two types of HTML files -  structured  documents
  35.        using headings (H1, H2, etc.) which _H_T_M_L_D_O_C calls "books",
  36.        and unstructured documents that do not use headings  which
  37.        _H_T_M_L_D_O_C calls "web pages".
  38.  
  39.        A  very  common  mistake  is  to try converting a web page
  40.        using:
  41.  
  42.        htmldoc -f filename.pdf filename.html
  43.  
  44.        which will likely produce a PDF file  with  no  pages.  To
  45.        convert  web  page files you mmuusstt use the _-_-_w_e_b_p_a_g_e option
  46.        at the command-line or choose _W_e_b _P_a_g_e in the input tab of
  47.        the GUI.
  48.  
  49. OOPPTTIIOONNSS
  50.        The  following command-line options are supported by _H_T_M_L_-
  51.        _D_O_C:
  52.  
  53.  
  54.        --batch _f_i_l_e_n_a_m_e_._b_o_o_k
  55.             Generates the specified book file without opening the
  56.             GUI.
  57.  
  58.  
  59.        --bodycolor _c_o_l_o_r
  60.             Specifies the background color for all pages.
  61.  
  62.  
  63.  
  64. 21 May 2001               HTMLDOC 1.8.13                        1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. htmldoc(1)            Easy Software Products           htmldoc(1)
  71.  
  72.  
  73.        --bodyfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  74.  
  75.        --textfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  76.             Specifies the default typeface for all normal text.
  77.  
  78.  
  79.        --bodyimage _f_i_l_e_n_a_m_e
  80.             Specifies  the  background image that is tiled on all
  81.             pages.
  82.  
  83.  
  84.        --book
  85.             Specifies that the HTML sources are structured (head-
  86.             ings, chapters, etc.)
  87.  
  88.  
  89.        --bottom _m_a_r_g_i_n
  90.             Specifies  the  bottom margin in points (no suffix or
  91.             ##pt), inches (##in), centimeters (##cm), or millime-
  92.             ters (##mm).
  93.  
  94.  
  95.        --charset _{_8_8_5_9_-_1_._._._8_8_5_9_-_1_5_}
  96.             Specifies  the  ISO character set to use for the out-
  97.             put.
  98.  
  99.  
  100.        --color
  101.             Specifies that PostScript or PDF output should be  in
  102.             color.
  103.  
  104.  
  105.        --datadir _d_i_r_e_c_t_o_r_y
  106.             Specifies  the  location  of  the _H_T_M_L_D_O_C data files,
  107.             usually _/_u_s_r_/_s_h_a_r_e_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m  _F_i_l_e_s_\_H_T_M_L_-
  108.             _D_O_C.
  109.  
  110.  
  111.        --duplex
  112.             Specifies  that  the  output  should be formatted for
  113.             double-sided printing.
  114.  
  115.  
  116.        --effectduration _{ _0_._1_._._1_0_._0 _}
  117.             Specifies the duration in seconds of PDF page transi-
  118.             tion effects.
  119.  
  120.  
  121.        --encryption
  122.             Enables encryption of PDF files.
  123.  
  124.  
  125.        --fontsize _s_i_z_e
  126.             Specifies the default font size for body text.
  127.  
  128.  
  129.  
  130. 21 May 2001               HTMLDOC 1.8.13                        2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. htmldoc(1)            Easy Software Products           htmldoc(1)
  137.  
  138.  
  139.        --fontspacing _s_p_a_c_i_n_g
  140.             Specifies the default line spacing for body text. The
  141.             line spacing is a multiplier for the font size, so  a
  142.             value  of 1.2 will provide an additional 20% of space
  143.             between the lines.
  144.  
  145.  
  146.        --footer _f_f_f
  147.             Sets the page footer to use on body  pages.  See  the
  148.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  149.  
  150.  
  151.        --format _f_o_r_m_a_t
  152.  
  153.        -t _f_o_r_m_a_t
  154.             Specifies   the   output  format:  html,  ps  or  ps2
  155.             (PostScript Level 2), ps1 (PostScript Level  1),  ps3
  156.             (PostScript  Level  3),  pdf11 (PDF 1.1/Acrobat 2.0),
  157.             pdf12  (PDF  1.2/Acrobat  3.0),  pdf  or  pdf13  (PDF
  158.             1.3/Acrobat 4.0), or pdf14 (PDF 1.4/Acrobat 5.0).
  159.  
  160.  
  161.        --gray
  162.             Specifies  that  PostScript  or  PDF output should be
  163.             grayscale.
  164.  
  165.  
  166.        --header _f_f_f
  167.             Sets the page header to use on body  pages.  See  the
  168.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  169.  
  170.  
  171.        --headfootfont _f_o_n_t
  172.             Sets the font to use on headers and footers.
  173.  
  174.  
  175.        --headfootsize _s_i_z_e
  176.             Sets the size of the font to use on headers and foot-
  177.             ers.
  178.  
  179.  
  180.        --headingfont _t_y_p_e_f_a_c_e
  181.             Sets the typeface to use for headings.
  182.  
  183.  
  184.        --help
  185.             Displays a summary of command-line options.
  186.  
  187.  
  188.        --helpdir _d_i_r_e_c_t_o_r_y
  189.             Specifies the location of the  _H_T_M_L_D_O_C  on-line  help
  190.             files,  usually  _/_u_s_r_/_s_h_a_r_e_/_d_o_c_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m
  191.             _F_i_l_e_s_\_H_T_M_L_D_O_C_\_D_O_C.
  192.  
  193.  
  194.  
  195.  
  196. 21 May 2001               HTMLDOC 1.8.13                        3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. htmldoc(1)            Easy Software Products           htmldoc(1)
  203.  
  204.  
  205.        --jpeg_[_=_q_u_a_l_i_t_y_]
  206.             Sets the JPEG compression  level  to  use  for  large
  207.             images. A value of 0 disables JPEG compression.
  208.  
  209.  
  210.        --left _m_a_r_g_i_n
  211.             Specifies  the  left  margin  in points (no suffix or
  212.             ##pt), inches (##in), centimeters (##cm), or millime-
  213.             ters (##mm).
  214.  
  215.  
  216.        --linkcolor _c_o_l_o_r
  217.             Sets the color of links.
  218.  
  219.  
  220.        --links
  221.             Enables generation of links in PDF files (default).
  222.  
  223.  
  224.        --linkstyle _{_p_l_a_i_n_,_u_n_d_e_r_l_i_n_e_}
  225.             Sets the style of links.
  226.  
  227.  
  228.        --logoimage _f_i_l_e_n_a_m_e
  229.             Specifies an image to be used as a logo in the header
  230.             or footer in a PostScript or PDF document, and in the
  231.             navigation bar of a HTML document.
  232.  
  233.  
  234.        --no-compression
  235.             Disables compression of PostScript or PDF files.
  236.  
  237.  
  238.        --no-duplex
  239.             Disables double-sided printing.
  240.  
  241.  
  242.        --no-encryption
  243.             Disables document encryption.
  244.  
  245.  
  246.        --no-jpeg
  247.             Disables JPEG compression of large images.
  248.  
  249.  
  250.        --no-links
  251.             Disables generation of links in a PDF document.
  252.  
  253.  
  254.        --no-numbered
  255.             Disables automatic heading numbering.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. 21 May 2001               HTMLDOC 1.8.13                        4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. htmldoc(1)            Easy Software Products           htmldoc(1)
  269.  
  270.  
  271.        --no-pscommands
  272.             Disables  generation of PostScript setpagedevice com-
  273.             mands.
  274.  
  275.  
  276.        --no-title
  277.             Disables generation of a title page.
  278.  
  279.  
  280.        --no-toc
  281.             Disables generation of a table of contents.
  282.  
  283.  
  284.        --no-truetype
  285.             Disables use of TrueType fonts in PDF output.
  286.  
  287.  
  288.        --numbered
  289.             Numbers all headings in a document.
  290.  
  291.  
  292.        --outdir _d_i_r_e_c_t_o_r_y
  293.  
  294.        -d _d_i_r_e_c_t_o_r_y
  295.             Specifies that output should be sent to  a  directory
  296.             in multiple files.  (Not compatible with PDF output)
  297.  
  298.  
  299.        --outfile _f_i_l_e_n_a_m_e
  300.  
  301.        -f _f_i_l_e_n_a_m_e
  302.             Specifies  that  output  should  be  sent to a single
  303.             file.
  304.  
  305.  
  306.        --owner-password _p_a_s_s_w_o_r_d
  307.             Sets the owner password for encrypted PDF files.
  308.  
  309.  
  310.        --pageduration _{_1_._0_._._6_0_._0_}
  311.             Sets the view duration of a page in a PDF document.
  312.  
  313.  
  314.        --pageeffect _e_f_f_e_c_t
  315.             Specifies the page transition effect for  all  pages;
  316.             this attribute is ignored by all Adobe PDF viewers...
  317.  
  318.  
  319.        --pagelayout _{_s_i_n_g_l_e_,_o_n_e_,_t_w_o_l_e_f_t_,_t_w_o_r_i_g_h_t_}
  320.             Specifies the initial layout of pages for a PDF file.
  321.  
  322.  
  323.        --pagemode _{_d_o_c_u_m_e_n_t_,_o_u_t_l_i_n_e_s_,_f_u_l_l_s_c_r_e_e_n_}
  324.             Specifies the initial viewing mode for a PDF file.
  325.  
  326.  
  327.  
  328. 21 May 2001               HTMLDOC 1.8.13                        5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. htmldoc(1)            Easy Software Products           htmldoc(1)
  335.  
  336.  
  337.        --path
  338.             Specifies a search path for files in a document.
  339.  
  340.  
  341.        --permissions _p_e_r_m_i_s_s_i_o_n
  342.             Specifies  document  permissions  for  encrypted  PDF
  343.             files. Multiple _-_-_p_e_r_m_i_s_s_i_o_n_s options are required to
  344.             grant  or  deny  specific  permissions. The following
  345.             values are understood: all, none, annotate,  no-anno-
  346.             tate,  copy,  no-copy,  modify, no-modify, print, and
  347.             no-print.
  348.  
  349.  
  350.        --pscommands
  351.             Specifies  that  PostScript  setpagedevice   commands
  352.             should be included in the output.
  353.  
  354.  
  355.        --quiet
  356.             Suppresses all messages, even error messages.
  357.  
  358.  
  359.        --right _m_a_r_g_i_n
  360.             Specifies  the  right  margin in points (no suffix or
  361.             ##pt), inches (##in), centimeters (##cm), or millime-
  362.             ters (##mm).
  363.  
  364.  
  365.        --size _p_a_g_e_s_i_z_e
  366.             Specifies  the  page size using a standard name or in
  367.             points (no suffix or ##x##pt), inches (##x##in), cen-
  368.             timeters  (##x##cm),  or  millimeters  (##x##mm). The
  369.             standard sizes  that  are  currently  recognized  are
  370.             "letter"   (8.5x11in),   "legal"   (8.5x14in),   "a4"
  371.             (210x297mm), and "universal" (8.27x11in).
  372.  
  373.  
  374.        --textcolor _c_o_l_o_r
  375.             Specifies the default color of all text.
  376.  
  377.  
  378.        --title
  379.             Enables the generation of a title page.
  380.  
  381.  
  382.        --titlefile _f_i_l_e_n_a_m_e
  383.  
  384.        --titleimage _f_i_l_e_n_a_m_e
  385.             Specifies the file to use for the title page. If  the
  386.             file is an image then the title page is automatically
  387.             generated using the  document  meta  data  and  title
  388.             image.
  389.  
  390.  
  391.  
  392.  
  393.  
  394. 21 May 2001               HTMLDOC 1.8.13                        6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. htmldoc(1)            Easy Software Products           htmldoc(1)
  401.  
  402.  
  403.        --tocfooter _f_f_f
  404.             Sets  the  page  footer  to  use on table-of-contents
  405.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  406.  
  407.  
  408.        --tocheader _f_f_f
  409.             Sets  the  page  header  to  use on table-of-contents
  410.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  411.  
  412.  
  413.        --toclevels _l_e_v_e_l_s
  414.             Sets the number of levels in the table-of-contents.
  415.  
  416.  
  417.        --toctitle _s_t_r_i_n_g
  418.             Sets the title for the table-of-contents.
  419.  
  420.  
  421.        --top _m_a_r_g_i_n
  422.             Specifies  the  top  margin  in  points (no suffix or
  423.             ##pt), inches (##in), centimeters (##cm), or millime-
  424.             ters (##mm).
  425.  
  426.  
  427.        --truetype
  428.             Enables use of TrueType fonts in PDF output.
  429.  
  430.  
  431.        --user-password _p_a_s_s_w_o_r_d
  432.             Specifies  the  user  password  for encryption of PDF
  433.             files.
  434.  
  435.  
  436.        --verbose
  437.  
  438.        -v
  439.             Provides verbose messages.
  440.  
  441.  
  442.        --webpage
  443.             Specifies that  the  HTML  sources  are  unstructured
  444.             (plain web pages.)
  445.  
  446.  
  447. HHEEAADDEERR//FFOOOOTTEERR FFOORRMMAATTSS
  448.        The header and footer of each page can contain up to three
  449.        preformatted values. These values are  specified  using  a
  450.        single  character  for  the left, middle, and right of the
  451.        page, resulting in the _f_f_f notation shown previously.
  452.  
  453.        Each character can be one of the following:
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460. 21 May 2001               HTMLDOC 1.8.13                        7
  461.  
  462.  
  463.  
  464.  
  465.  
  466. htmldoc(1)            Easy Software Products           htmldoc(1)
  467.  
  468.  
  469.        blank
  470.  
  471.  
  472.        /
  473.             n/N arabic page numbers (1/3, 2/3, 3/3)
  474.  
  475.  
  476.        :
  477.             c/C arabic chapter page numbers (1/2, 2/2, 1/4,  2/4,
  478.             ...)
  479.  
  480.  
  481.        1
  482.             arabic numbers (1, 2, 3, ...)
  483.  
  484.  
  485.        a
  486.             lowercase letters
  487.  
  488.  
  489.        A
  490.             uppercase letters
  491.  
  492.  
  493.        c
  494.             current chapter heading
  495.  
  496.  
  497.        C
  498.             current chapter page number (arabic)
  499.  
  500.  
  501.        d
  502.             current date
  503.  
  504.  
  505.        D
  506.             current date and time
  507.  
  508.  
  509.        h
  510.             current heading
  511.  
  512.  
  513.        i
  514.             lowercase roman numerals
  515.  
  516.  
  517.        I
  518.             uppercase roman numerals
  519.  
  520.  
  521.        l
  522.             logo image
  523.  
  524.  
  525.  
  526. 21 May 2001               HTMLDOC 1.8.13                        8
  527.  
  528.  
  529.  
  530.  
  531.  
  532. htmldoc(1)            Easy Software Products           htmldoc(1)
  533.  
  534.  
  535.        t
  536.             title text
  537.  
  538.  
  539.        T
  540.             current time
  541.  
  542.  
  543. SSEEEE AALLSSOO
  544.        HTMLDOC 1.8.13 Software Users Manual
  545.  
  546.        http://www.easysw.com/htmldoc
  547.  
  548. AAUUTTHHOORR
  549.        Michael Sweet (mike@easysw.com), Easy Software Products
  550.  
  551. TTRRAADDEEMMAARRKKSS
  552.        PostScript  is  a trademark that may be registered in some
  553.        countries and Adobe is a  registered  trademark  of  Adobe
  554.        Systems Incorporated.
  555.  
  556. CCOOPPYYRRIIGGHHTTSS
  557.        Portable Document Format Copyright 1993-1999 by Adobe Sys-
  558.        tems Incorporated.
  559.  
  560.        HTMLDOC is copyright 1997-2001 by Easy Software  Products.
  561.        This  program  is  free  software; you can redistribute it
  562.        and/or modify it under the terms of the GNU General Public
  563.        License  as  published  by  the  Free Software Foundation;
  564.        either version 2 of the License, or (at your  option)  any
  565.        later version.
  566.  
  567.        This  program is based in part on the work of the Indepen-
  568.        dent JPEG Group.
  569.  
  570. NNOO WWAARRRRAANNTTYY
  571.        This program is distributed in the hope that  it  will  be
  572.        useful, but WITHOUT ANY WARRANTY; without even the implied
  573.        warranty of MERCHANTABILITY or FITNESS  FOR  A  PARTICULAR
  574.        PURPOSE.   See  the  GNU  General  Public License for more
  575.        details.
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592. 21 May 2001               HTMLDOC 1.8.13                        9
  593.  
  594.  
  595.